home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / telecomm / bbs / wwbbs26.lha / WWBBS / WWBBS.doc < prev   
Encoding:
Text File  |  1995-01-29  |  12.9 KB  |  517 lines
  1. World Wide BBS 2.6 (28.1.95)
  2. Copyright © 1995 Arthur Choung
  3. ---
  4. Main Features:
  5.  
  6.      o Is a commodity.
  7.  
  8.      o Has nice GUI, thanks to triton.library.
  9.  
  10.      o Everything runs through stdio, so every program you can run through
  11.        the shell you can run through the BBS.
  12.  
  13.      o Supports HydraCom for bidirectional transfers.
  14.  
  15. Requirements:
  16.  
  17.      o Kickstart 2.04, but the higher the better.
  18.  
  19.      o ARexx
  20.  
  21.      o triton.library
  22.  
  23. Optional:
  24.  
  25.      o OwnDevUnit.library
  26.  
  27.  
  28. Installation
  29. ---
  30.  
  31.      Double-click on the Install icon.
  32.  
  33.      If you are upgrading from an older version, please read the file
  34. History.doc to brief you on the program's changes.
  35.  
  36.  
  37. Using WWBBS
  38. ---
  39.  
  40.      Double-click on the WWBBS icon.  It has all the properties that a
  41. commodity has.
  42.  
  43.      On the top-left is the node list.  You can double-click on a local
  44. node to logon, and on a remote node when a user is online to open a viewing
  45. console.
  46.  
  47.      On the top-right is the action list.  You can click on an action, and
  48. it will execute that command.  You can also pass along the currently
  49. selected node to that command.  This is configurable through the tool
  50. types.  For every action to add, put in this line in this format:
  51.  
  52.      ACTION=<Name>,<Command>
  53.  
  54.           Name=Name of action to put in listview
  55.           Command=Full path of command to execute.  If you would like to
  56.                   pass along the node, substitute a "%s" (including quotes)
  57.                   and it will pass along the node's id.
  58.  
  59.      Note that when you click on the close window gadget, it does not quit
  60. the program because it is a commodity.  Also when doing substition type
  61. arguments such as in Command above, always include quotes unless otherwise
  62. noted.
  63.  
  64.  
  65. Using BBSPrefs
  66. ---
  67.  
  68.      Double-click on the BBSPrefs icon.  It is a normal program.  Note that
  69. some of the windows opened in this program are pretty big so you may need a
  70. larger screen if the window won't open up.
  71.  
  72.      There are eleven sub-prefs.  They include:
  73.  
  74.           Access Groups
  75.                These are the access groups you can select for a
  76.                user.
  77.  
  78.           Archivers
  79.                These are the archivers that the user can choose from.
  80.  
  81.           Door Variables
  82.                All of these variables are set as local environment
  83.                variables that the can be read by the programs run from the
  84.                bbs.
  85.  
  86.           Editors
  87.                These are the editors that the user can choose from.
  88.  
  89.           File Bases
  90.                These are the file bases.
  91.  
  92.           Menus
  93.                This is the menu tree.
  94.  
  95.           Message Bases
  96.                These are the message bases.
  97.  
  98.           News
  99.                These are the news file to inform the user of any changes.
  100.  
  101.           Nodes
  102.                These are the node configurations.
  103.  
  104.           Protocols
  105.                These are the protocols that the user can choose fom.
  106.  
  107.           System
  108.                These are options that configure the entire system.
  109.  
  110.      There are basically two types of prefs.  One has a list of items you
  111. can edit, and the other allows you to create a tree, as in sub-directories.
  112. File Base Prefs, Menu Prefs, and Message Base Prefs fall into the latter
  113. category.  You can use the arrow keys to navigate the tree.  System Prefs
  114. is different from all the other prefs in that there are only options to
  115. set, and no list.
  116.  
  117.  
  118. Using AccessGroupPrefs
  119. ---
  120.  
  121. These are the fields:
  122.  
  123.      Access Level
  124.           This is the access level of the user.  0 is equivalent to being
  125.           banned from the bbs, 1 is a new user, and 255 is the almighty
  126.           sysop.
  127.  
  128.      Session Time Limit
  129.           In minutes.
  130.  
  131.      Inactivity Time Limit
  132.           In minutes.
  133.  
  134.      Ratio Byte
  135.           Byte ratio for the file base.  0 is no ratio.
  136.  
  137.      Ratio File
  138.           File ratio for the file base.  0 is no ratio.
  139.  
  140.      Days
  141.           Number of days of inactivity before being deleted by UserMaint.
  142.  
  143.  
  144. Using ArchiverPrefs
  145. ---
  146.  
  147.      Extension
  148.           Archiver extension so it can be identified.
  149.  
  150.      Add Command
  151.           Full path of command to run, substituting "%a" for the archive
  152.           and "%f" for the file to be added.
  153.  
  154.      Extract Command
  155.           Full path of command to run, substituting "%s" for the archive.
  156.  
  157.      View Command
  158.           Full path of command to run, substituting "%s" for the archive.
  159.  
  160.  
  161. Using DoorVarPrefs
  162. ---
  163.  
  164.      String
  165.           Sets the variable specified by its name to whatever is in this
  166.           string.
  167.  
  168.           Note that the following variables can be used in string:
  169.  
  170.                @BAUD
  171.                @NODENAME
  172.                @USERNAME
  173.                @REALNAME
  174.                @UUCPNAME
  175.                @HOMEDIR
  176.                @ACCESSLEVEL
  177.                @BYTERATIO
  178.                @FILERATIO
  179.                @SCREENWIDTH
  180.                @SCREENHEIGHT
  181.                @EDITOR
  182.                @PROTOCOLSEND
  183.                @PROTOCOLRECEIVE
  184.                @ARCHIVERADD
  185.                @ARCHIVEREXTRACT
  186.                @ARCHIVERVIEW
  187.  
  188.           For example, putting @BAUD in string will be set to whatever the
  189.           current baud rate is.
  190.  
  191.      You can use these variables with the DOSCOMMAND command.  Simply add a
  192.      $ in front of the variable name.  For example,
  193.  
  194.           DOSCOMMAND C:Echo $USERNAME
  195.  
  196.      will echo the current user's name.
  197.  
  198.      You can actually use these variables anywhere, since they are DOS
  199.      environment variables.  For example, if you are running a script from
  200.      within the BBS, one line could be:
  201.  
  202.           $EDITOR T:editor_file
  203.  
  204.      which would run the current editor with T:editor_file as the argument.
  205.  
  206.  
  207. Using EditorPrefs
  208. ---
  209.  
  210.      Type
  211.           Standard is any normal editor which runs through the shell and
  212.           does not need ANSI.  Visual is like standard but for editors that
  213.           need ANSI.  Graphical is for local users so you can run your
  214.           favorite editor.
  215.  
  216.      Command
  217.           Full path of command to run.  The file name will be appended to
  218.           the end of the string, unless you insert a "%f" (including
  219.           quotes), at which point it will substitute the filename in place
  220.           of the "%f".
  221.  
  222.      Stack
  223.           Stack size to give command.
  224.  
  225.  
  226. Using FileBasePrefs
  227. ---
  228.  
  229.      Access Range
  230.           Range of access levels to accept, using commands and dashes.  For
  231.           example, 1-255 means everything between 1 and 255, including 1
  232.           and 255, 1-5,255 means one through five and 255, etc.
  233.  
  234.      Group
  235.           ID name of group.  Try to keep these simple, no spaces and
  236.           only lowercase letters.  Try names them with a usenet style
  237.           heirarchy.
  238.           For example, util, util.disk, util.wb, etc.
  239.  
  240.      Directory
  241.           Directory to use for this group.
  242.  
  243.      Disk Space Required
  244.           Disk space required for upload in kilobytes.
  245.  
  246.      Days
  247.           How many days of inactivity before deleting files by FileMaint.
  248.  
  249.      Read Only
  250.           No uploading.
  251.  
  252.      Auto Join
  253.           Automatically join this group for new users.
  254.  
  255.  
  256. Using MenuPrefs
  257. ---
  258.  
  259.      Access Range
  260.  
  261.      Character
  262.           Character of the command.
  263.  
  264.      Default
  265.           For menus with sub-menus.  When you press return this command
  266.           will be executed.
  267.  
  268.      Number
  269.           For menus with sub-menus.  When you press a digit this command
  270.           will be executed and the digit will be passed along.
  271.  
  272.      Prompt
  273.           For menus with sub-menus.  This is the prompt to print.  You can
  274.           use \e to pass ESC, \t for TAB, \b for BS, \n for newline, \f to
  275.           clear screen, and %t for time remaining.  No quotes are needed.
  276.  
  277.      Command
  278.           For normal menu items.  You can specify ABBEREXX commands and
  279.           System commands.
  280.  
  281.      When displaying a menu, WWBBS will first search for
  282. "WWBBS:Menus/{menu name>.<ascii|ansi>", and if it exists, it will display
  283. it.  Otherwise it will just show the standard menu.  For example, an ansi
  284. user in the main menu will see "WWBBS:Menus/Main.ansi", if it exists.
  285.     When creating custom menu files, you can add keycodes to hide certain
  286. menu items from users according to their access level.  At the beginning of
  287. a line, put:
  288.  
  289.           @<accesslevel range>@
  290.  
  291. For example, @1-128,255@ will show this line to users with accesslevels in
  292. the range of 1 to 128, and 255.
  293.  
  294.  
  295. Using MessageBasePrefs
  296. ---
  297.  
  298.      Access Range
  299.  
  300.      Group
  301.           ID name of group.  No spaces are allowed.  Try to use only
  302.           lowercase letters, and try to name them with a usenet style
  303.           heirarchy.
  304.           For example, computer_talk.amiga, computer_talk.ibm.
  305.  
  306.      Quote Header
  307.           Quote header for replies.  Substitute %d for date and %n for
  308.           name.
  309.  
  310.      Read Only
  311.           No posting.
  312.  
  313.      Auto Join
  314.           Automatically join this group for new users.
  315.  
  316.  
  317. Using NewsPrefs
  318. ---
  319.  
  320.      Access Range
  321.  
  322.      File
  323.           File to show user.
  324.  
  325.      Date
  326.  
  327.  
  328. Using NodePrefs
  329. ---
  330.  
  331.      Access Range
  332.  
  333.      Type
  334.           Local is for use locally.  Remote is for remote use.
  335.  
  336.      Device
  337.           For remote nodes only.  Device to use.
  338.  
  339.      Unit
  340.           For remote nodes only.  Unit of device to use.
  341.  
  342.      Buffer Size
  343.           For remote nodes only.  Buffer Size to allocate.
  344.  
  345.      Baud
  346.           For remote nodes only.  Baud rate.
  347.  
  348.      Handshaking
  349.           For remote nodes only.  RTS/CTS handshaking.
  350.  
  351.      Auto Baud
  352.           For remote nodes only.  When answering call, should you change
  353.           baud rate to match?  For error-detecting/compression modems, you
  354.           should not set this.
  355.  
  356.      Front End
  357.           For remote nodes only.  Use StartSession to start a session from
  358.           TrapDoor or UUCICO.
  359.  
  360.      Command
  361.           Command to execute for each session.  Remember that anything that
  362.           runs through shell can be used here.  You should provide a delay
  363.           of about three seconds on remote nodes to allow other side to do
  364.           whatever it needs to do.
  365.  
  366.  
  367. Using ProtocolPrefs
  368. ---
  369.  
  370.      Send Command
  371.      Receive Command
  372.           Command to execute.  Substitute:
  373.                "%d" for device name.
  374.                %u for device unit.
  375.                "%l" for unique log file name.
  376.                "%F" for input file list.
  377.                "%f" for file name.
  378.                "%n" for user name.
  379.  
  380.      Batch
  381.           Protocol handles batch transfers.
  382.  
  383.      Bidirectional
  384.           Protocol handlers bidirectional transfers.
  385.  
  386.  
  387. Using SystemPrefs
  388. ---
  389.  
  390.      Display Mode
  391.           Display mode of console.
  392.  
  393.      Font
  394.           Font of console
  395.  
  396.      Only Real Names
  397.           Don't allow aliases.
  398.  
  399.      Header Color
  400.      Input Color
  401.      Output Color
  402.      Prompt Color
  403.      System Color
  404.           String for <fill> color.  Send \e for ESC, \t for TAB, \b for BS,
  405.           \n for newline, \f to clear screen.
  406.  
  407.  
  408. Using Editor
  409. ---
  410.  
  411.      Simple editor.  Usage:
  412.  
  413.           Editor <file name>
  414.  
  415.  
  416. Using ForceLogOff
  417. ---
  418.  
  419.      Run by WWBBS as an action.  Usage:
  420.  
  421.           ForceLogOff <node id>
  422.  
  423.  
  424. Using LogMaint
  425. ---
  426.  
  427.      Run it to trim logs.
  428.  
  429.      The template is:
  430.  
  431.           LogMaint Days/N
  432.  
  433.      Where `Days' is how old the logs have to be before deleting them.
  434.  
  435.  
  436. Using LogViewer
  437. ---
  438.  
  439.      Figure it out.
  440.  
  441.  
  442. Using BBSRx
  443. ---
  444.  
  445.      This runs .rexx files while interpreting ABBEREXX, System, Email,
  446. MsgBase, and FileBase commands...see the appropriate doc files for a list
  447. of commands.
  448.  
  449.      The template is:
  450.  
  451.           BBSRx File/A
  452.  
  453.  
  454. Using StartSession
  455. ---
  456.  
  457.      Use this in conjunction with TrapDoor and UUCICO.  Usage:
  458.  
  459.           StartSession <node> [-BAUD <baud>]
  460.  
  461.      The node that you use it with must be denoted as a `Front End', and
  462.      you must open the serial.device in shared mode from within whatever
  463.      program you are using.
  464.  
  465.  
  466. Using UserEditor
  467. ---
  468.  
  469.      See LogViewer.
  470.  
  471.  
  472. Using UserMaint
  473. ---
  474.  
  475.      Just run it to trim users.
  476.  
  477.  
  478. Using XPR
  479. ---
  480.  
  481.      This tool handles XPR transfers.  Usage:
  482.  
  483.           Command/R,D=Device/K,U=Unit/N,L=Library/K/R,I=Init/K,Log/K,
  484.           FL=FileList/K,FN=FileName/K,ID=UserID/K,RES=Resume/S
  485.  
  486.      Where:
  487.  
  488.           Command:  S=Send or R=Receive
  489.           Device:   serial device, default is "serial.device"
  490.           Unit:     unit, default is 0
  491.           Library:  xpr.library
  492.           Init:     init string, if not specified, will use ENVARC:
  493.           Log:      name of log file (DSZ-style)
  494.           FileList: name of file list for batch send*
  495.           FileName: name of file for single file send
  496.           UserID:   use with resume
  497.           Resume:   if result is supported, all aborted files (receive)
  498.                     have a id tag attached to them.  otherwise they are
  499.                     deleted.
  500.  
  501.      * A file list is a text file with one filename per line.
  502.  
  503.  
  504. Author
  505. ---
  506.  
  507.      World Wide BBS is now shareware.  If you use this program, I request
  508.      that you send me a donation of US$30.  In return I will send you all
  509.      updates.  Only registered users will have access to updates, unless
  510.      there is a silly bug that prevents users from evaluating this program.
  511.  
  512.      If you would like to contact me:
  513.  
  514.           Internet: choung@seas.ucla.edu or arthur@qedbbs.com
  515.           US Mail: 10324 Chestnut Street, Bellflower, CA 90706 USA
  516.  
  517.